Skip to content

{Spring} Fix previous error which hides the extension docs planned for deprecation#9112

Closed
yuwzho wants to merge 5 commits intoAzure:mainfrom
yuwzho:yuwzho/asa-doc
Closed

{Spring} Fix previous error which hides the extension docs planned for deprecation#9112
yuwzho wants to merge 5 commits intoAzure:mainfrom
yuwzho:yuwzho/asa-doc

Conversation

@yuwzho
Copy link
Copy Markdown
Contributor

@yuwzho yuwzho commented Sep 1, 2025


This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • My extension version conforms to the Extension version schema

For new extensions:

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

Copilot AI review requested due to automatic review settings September 1, 2025 09:12
@azure-client-tools-bot-prd
Copy link
Copy Markdown

azure-client-tools-bot-prd Bot commented Sep 1, 2025

⚠️Azure CLI Extensions Breaking Change Test
⚠️spring
rule cmd_name rule_message suggest_message
⚠️ 1014 - SubgroupPropRemove spring sub group spring removed property deprecate_info_hide

@azure-client-tools-bot-prd
Copy link
Copy Markdown

Hi @yuwzho,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

@yonzhan
Copy link
Copy Markdown
Collaborator

yonzhan commented Sep 1, 2025

Thank you for your contribution! We will review the pull request and get back to you soon.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Azure CLI Spring extension to show deprecation documentation by removing the hide=True parameter from the command group deprecation registration. The change makes the deprecation notice visible to users instead of hiding it.

  • Version bump from 1.28.3 to reflect the change
  • Modified deprecation registration to show the extension deprecation notice
  • Updated history with release notes

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/spring/setup.py Version bump from 1.28.2 to 1.28.3
src/spring/azext_spring/_breaking_change.py Removed hide=True parameter to make deprecation notice visible
src/spring/HISTORY.md Added release notes for version 1.28.3

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 1, 2025

The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR.

Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 1, 2025

CodeGen Tools Feedback Collection

Thank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 1, 2025

@github-actions github-actions Bot added the release-version-block Updates do not qualify release version rules. NOTE: please do not edit it manually. label Sep 1, 2025
@github-actions github-actions Bot removed the release-version-block Updates do not qualify release version rules. NOTE: please do not edit it manually. label Sep 1, 2025
@dingmeng-xue
Copy link
Copy Markdown
Member

I suggest making a minor change rather than version change. Please wait my new PR.

@dingmeng-xue
Copy link
Copy Markdown
Member

@zhoxing-ms , if the extension 1.28.2 is not released, I prefer to using PR #9113 to release 2 changes together. If the extension 1.28.2 has been released, I don't think we need to release a new version because #9113 is just for reference doc generation.

Please help me double check.

@zhoxing-ms
Copy link
Copy Markdown
Contributor

@dingmeng-xue Suggest using the az extension list-versions --name spring command in the future to check if the version of the extension has been released
We can see that the extension version 1.28.2 of spring extension has been released.

image

@dingmeng-xue
Copy link
Copy Markdown
Member

@dingmeng-xue Suggest using the az extension list-versions --name spring command in the future to check if the version of the extension has been released We can see that the extension version 1.28.2 of spring extension has been released.

image

Thanks. I created a PR to bump a patch version. #9113

@calvinhzy calvinhzy changed the title Show the extension doc {Spring} Fix previous error which hides the extension docs planned for deprecation Sep 2, 2025
@calvinhzy calvinhzy closed this Sep 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants